Payments v2

Get a payment

Changed on

The GET /v2/payments/{paymentId} endpoint provides you with details of an individual payment and checks the payment status for the next step, if any.

get/v2/payments/{paymentId}

Request

  • Base URL
    https://api.token.io
  • URL
    https://api.token.io/v2/payments/{paymentId}
  • Auth
    • HTTP bearer
    • or API key in header Authorization

Path parameters

paymentIdstring required

The payment id.

Headers

request-timeoutinteger

Sets the number of elapsed seconds until Token.io sends the response back, even if the call is not finished by that time (in which case the call will be completed asynchronously).

Response

Successful response

Example response

{
  "payment": {
    "id": "pm:12345abcd:abcd",
    "memberId": "m:123456abcd:abcd",
    "initiation": {
      "bankId": "ob-modelo",
      "refId": "9htio4a1sp2akdr1aa",
      "remittanceInformationPrimary": "Sweepco",
      "remittanceInformationSecondary": "Secondary remittance information.",
      "onBehalfOfId": "c5a863bc-86f2-4418-a26f-25b24c7983c7",
      "amount": {
        "value": "10.23",
        "currency": "EUR"
      },
      "localInstrument": "SEPA",
      "debtor": {
        "iban": "GB29NWBK60161331926819",
        "bic": "BOFIIE2D",
        "address": {
          "addressLine": [
            "The Coach House"
          ],
          "streetName": "221B",
          "buildingNumber": "2C",
          "postCode": "TR26 1EZ",
          "townName": "Saint Ives",
          "state": "Cornwall",
          "country": "GB"
        }
      },
      "creditor": {
        "iban": "GB29NWBK60161331926819",
        "bic": "BOFIIE2D",
        "name": "Customer Inc.",
        "ultimateCreditorName": "Customer Inc.",
        "address": {
          "addressLine": [
            "The Coach House"
          ],
          "streetName": "221B",
          "buildingNumber": "2C",
          "postCode": "TR26 1EZ",
          "townName": "Saint Ives",
          "state": "Cornwall",
          "country": "GB"
        }
      },
      "executionDate": "2023-04-29",
      "returnTokenizedAccount": true,
      "callbackUrl": "https://tpp.com/callback",
      "callbackState": "6242e45e-3063-4c42-8376",
      "chargeBearer": "CRED",
      "risk": {
        "psuId": "0000789123",
        "paymentContextCode": "PISP_PAYEE",
        "paymentPurposeCode": "DVPM",
        "merchantCategoryCode": "4812",
        "beneficiaryAccountType": "BUSINESS",
        "contractPresentIndicator": true,
        "beneficiaryPrepopulatedIndicator": true,
        "deliveryAddress": {
          "addressLine": [
            "Flat 2, The Red Lodge, 1 High Street"
          ],
          "addressType": "BUSINESS",
          "buildingNumber": "1",
          "country": "GB",
          "countrySubDivision": [
            "North Yorkshire"
          ],
          "department": "1",
          "postCode": "YO62 5JB",
          "streetName": "High Street",
          "subDepartment": "Flat 2",
          "townName": "York"
        }
      },
      "flowType": "FULL_HOSTED_PAGES",
      "externalPsuReference": "psu external reference 12345",
      "metadata": {
        "orderId": "ORD-98213",
        "customerRef": "cust_44821"
      }
    },
    "refundDetails": {
      "refundAccount": {
        "iban": "GB29NWBK60161331926819",
        "bic": "BOFIIE2D",
        "name": "John Smith"
      },
      "paymentRefundStatus": "NONE",
      "settledRefundAmount": {
        "value": "10.23",
        "currency": "EUR"
      },
      "remainingRefundAmount": {
        "value": "10.23",
        "currency": "EUR"
      }
    },
    "status": "INITIATION_COMPLETED",
    "statusReasonInformation": "The payment is settled on the debtor side.",
    "bankPaymentStatus": "ACPC",
    "bankPaymentId": "1231423",
    "bankTransactionId": "2UhwCZ3BMaEcAUK8bZdukor7NL4tH6TBuu6aJMp5KKfX:5zKcENpV",
    "bankVrpStatus": "AcceptedCreditSettlementCompleted",
    "authentication": {
      "redirectUrl": "http://psu-redirect.com"
    },
    "createdDateTime": "2023-04-05T17:02:11.954Z",
    "updatedDateTime": "2023-04-05T17:02:11.954Z",
    "errorInfo": {
      "httpErrorCode": 503,
      "message": "UNAVAILABLE: HTTP connection failed",
      "tokenExternalError": true,
      "tokenTraceId": "eASI3Onqkpi1unAM59O5"
    },
    "paymentLinkStatus": "LINK_ACTIVE"
  }
}

Changes