Step 3 - Settle a payment

This step confirms the transaction, after which we will send the payment order to the paying bank.

The only parameter not mandatory to consider is 'WebHookUrl'; this URL is used to post notifications about the payment status.

Payment status can be retrieved in two ways: by using a webhook or by executing the 'get payment' method. It is advisable to implement both methods.

API Call

Submit the transaction

post

Authorizations

oauth2-implicitoauth2-client-credentials

Path parameters

idstring · uuidRequired

Identifier.

Body

application/json-patch+jsonapplication/jsonapplication/*+json

webHookUrlstringOptional

Responses

200

If the Payment was settled

application/json

400

If the request body is not correct

401

Unauthorized

402

If the balance is insufficient

403

Forbidden

404

If the id don't exists

409

If the Payment was already settled

412

If the Payment wan't locked

post

HTTPcURLJavaScriptPython

POST /api/Payments/{id}/Settle HTTP/1.1
Host: 
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 119

{
  "webHookUrl": "text",
  "ledgerInfo": {
    "crytoNetworkCode": "text",
    "cryptoCurrencyName": "text",
    "cryptoTransactionId": "text"
  }
}

application/json-patch+jsonapplication/jsonapplication/*+json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "C2C",
  "createdAt": "2025-05-04T00:51:15.838Z",
  "quoteId": "123e4567-e89b-12d3-a456-426614174000",
  "payerId": 1,
  "debitAmount": 1,
  "debitCurrency": "text",
  "fxRate": 1,
  "amount": 1,
  "currency": "text",
  "collectMethod": "CASH_PICKUP",
  "referenceId": "text",
  "userInfo": {
    "Dbtr": {
      "StrdNm": {
        "FirstNm": "text",
        "LastNm": "text"
      },
      "PstlAdr": {
        "Ctry": "text",
        "CtrySubDvsn": "text",
        "TwnNm": "text",
        "AdrLine": "text",
        "PstCd": "text"
      },
      "Id": {
        "PrvtId": {
          "Othr": {
            "Id": "text",
            "Issr": "text",
            "SchmeNm": {
              "Cd": "ARNU",
              "Prtry": "text"
            }
          },
          "DtAndPlcOfBirth": {
            "BirthDt": "text",
            "CtryOfBirth": "text"
          }
        },
        "OrgId": {
          "Othr": {
            "Id": "text",
            "Issr": "text",
            "SchmeNm": {
              "Cd": "ARNU",
              "Prtry": "text"
            }
          }
        }
      },
      "CtctDtls": {
        "EmailAdr": "text",
        "PhneNb": "text",
        "Othr": "text"
      },
      "Nm": "text"
    },
    "Cdtr": {
      "StrdNm": {
        "FirstNm": "text",
        "LastNm": "text"
      },
      "PstlAdr": {
        "Ctry": "text",
        "CtrySubDvsn": "text",
        "TwnNm": "text",
        "AdrLine": "text",
        "PstCd": "text"
      },
      "Id": {
        "PrvtId": {
          "Othr": {
            "Id": "text",
            "Issr": "text",
            "SchmeNm": {
              "Cd": "ARNU",
              "Prtry": "text"
            }
          },
          "DtAndPlcOfBirth": {
            "BirthDt": "text",
            "CtryOfBirth": "text"
          }
        }
      },
      "CtctDtls": {
        "EmailAdr": "text",
        "PhneNb": "text",
        "Othr": "text"
      }
    },
    "CdtrAgt": {
      "FinInstnId": {
        "BICFI": "text"
      },
      "BrnchId": {
        "Id": "text"
      }
    },
    "CdtrAcct": {
      "Id": {
        "Othr": {
          "Id": "text"
        }
      },
      "Tp": {
        "Cd": "SVGS"
      }
    },
    "Purp": {
      "Prtry": "FAMILY_SUPPORT"
    },
    "InstForCdtrAgt": {
      "InstrInf": "text"
    },
    "PmtId": {
      "TxId": "text"
    }
  },
  "status": "CREATED",
  "subState": "FORWARDED",
  "lockDeclineReason": "text",
  "lockDeclineDescription": "text",
  "reverseReason": "text",
  "withholdingPercentages": {
    "vatWithholdingPercentage": 1,
    "incomeWithholdingPercentage": 1,
    "vatWithholdingReceiptUrl": "text",
    "incomeWithholdingReceiptUrl": "text"
  },
  "payerPaymentCode": "text",
  "transactionId": 1,
  "lockedAt": "2025-05-04T00:51:15.838Z",
  "lockDeclinedAt": "2025-05-04T00:51:15.838Z",
  "expiredAt": "2025-05-04T00:51:15.838Z",
  "settledAt": "2025-05-04T00:51:15.838Z",
  "forwardedAt": "2025-05-04T00:51:15.838Z",
  "awaitingCollectionSince": "2025-05-04T00:51:15.838Z",
  "completedAt": "2025-05-04T00:51:15.838Z",
  "reversedAt": "2025-05-04T00:51:15.838Z",
  "liquidityError": true,
  "invoiceUrl": "text"
}