v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB

Payments v2

Provide information for embedded authentication

The POST /v2/payments/{paymentId}/embedded-auth endpoint provides you with the requested information when the payment status is INITIATION_PENDING_EMBEDDED_AUTH. The requested information can be found in the authentication field of the payment. <br/> <br/> It's possible that some banks might request the user's input multiple times. In this case you might need to call this endpoint again for a new field set.

post/v2/payments/{paymentId}/embedded-auth

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).

Request body

embeddedAuthEmbeddedAuthFields

This field provides a map of all fields requested for embedded authentication, with their values. The key is the id of the field from the authentication payload, for which this value is submitted.

Example request

{
  "embeddedAuth": {
    "123": "SMS message"
  }
}

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"
    },
    "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"
  }
}