OPopen-finance

Get ATM code status for a payment

Retrieves the ATM code status and code (if generated) for a specific payment

get/atm/code/{paymentId}

Request

  • Base URL
    https://api.open-finance.ai/v2
  • URL
    https://api.open-finance.ai/v2/atm/code/{paymentId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.open-finance.ai/oauth/token scopes: read:payments

Path parameters

paymentIdstring required

The unique identifier for the payment transaction

Response

ATM code status and code (if generated)

status'DONE' | 'PENDING'

Status of the ATM code (PENDING, DONE)

atmCodestring

The ATM code (if generated)

paymentIdstring

ID of the payment

Example response

{
  "atmCode": "9191",
  "paymentId": "01JSVE747K9SNQ6KMN9GKSS7N3"
}

Changes

No recorded changes to this operation across all 1 revision of this API.