# get a payment by id

This API is intended for merchants requiring information on a specific payment. 
Onboarded merchants should have api keys for each profile, the api key will carry the profileId information required to find the correct creditor in the merchant-service

The token/api-key necessary to call this endpoint must contain:

*  :  or 
* : ,
* : 

Endpoint: GET /v3/payments/{id}
Version: 3.6.3
Security: api_key_payment_profile, JWS-Request-Signature-Payment

## Path parameters:

  - `id` (string, required)

## Response 200 fields (application/json):

  - `paymentId` (string, required)
    id of the payment

  - `createdAt` (string, required)
    the creation time of the payment

  - `expireAt` (string, required)
    the time from which the payment will be expired

  - `succeededAt` (string)
    if the payment is SUCCEEDED, then this field represents the date-time on which the payment was SUCCEEDED

  - `currency` (string, required)
    Currency code. Only EUR is supported [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217)
    Enum: "EUR"

  - `status` (string, required)
    | Status | Description |
|--------|-------------|
| PENDING | The merchant has created the payment and and is pending to proceed with identify step. |
| IDENTIFIED | The user has scanned the payment's QR code with the Payconiq By Bancontact APP. |
| AUTHORIZED | The user has confirmed the payment and the bank authorized it. |
| AUTHORIZATION_FAILED | The authorization with the bank failed. |
| FAILED | Something went wrong during the payment process(e.g authorization failed). |
| SUCCEEDED | The payment has succeeded. |
| CANCELLED | When the payment has been canceled after the user has scanned it, or the merchant has cancelled the payment.|
| EXPIRED | The payment has expired. |
| PENDING_MERCHANT_ACKNOWLEDGEMENT | The payment is waiting for the merchant to acknowledge. |
| VOIDED | The payment has been voided |
    Enum: "PENDING", "IDENTIFIED", "AUTHORIZED", "AUTHORIZATION_FAILED", "SUCCEEDED", "FAILED", "CANCELLED", "EXPIRED", "PENDING_MERCHANT_ACKNOWLEDGEMENT", "VOIDED"

  - `creditor` (object, required)
    Creditor account set to receive the payment

  - `creditor.profileId` (string)
    The configuration ID of the Merchant

  - `creditor.merchantId` (string)
    the Id of the merchant

  - `creditor.name` (string)
    Merchant's company name that will be shown to the debtor

  - `creditor.iban` (string)
    Creditor's Bank Account Iban to where the money will be sent to for this current payment

  - `creditor.identifyCallbackUrl` (string)
    callbackUrl to which the merchant will be notified about the payment identification

  - `creditor.callbackUrl` (string)
    callbackUrl to which the merchant will be notified about the payment payout

  - `debtor` (object)

  - `debtor.name` (string)
    First name of Debtor

  - `debtor.iban` (string)
    IBAN of Debtor masked

  - `amount` (integer, required)
    Amount in cents originally requested. If no amount was requested by creditor, this will be 0

  - `description` (string)
    merchant's description of the payment

  - `message` (string)
    debtor's message of the payment

  - `reference` (string)
    Merchant payment reference, used to reference the Bancontact Payconiq Company payment. The characters used must comply with the [SEPA Requirements for an Extended Character Set (UNICODE Subset) - Best Practices | European Payments Council](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). in the merchant's system

  - `bulkId` (string)
    Field used to reference a bulk batch, so the merchant can choose how to bulk the payments. Mandatory if  merchant profile does have bulking enabled, otherwise will miss from the response. If it's not set in the create call it will default to the value configured in the profile if it exists, otherwise its value will be defaulted by the application.

  - `_links` (object)
    Provides information to navigate to our REST interfaces dynamically, by including hypermedia links to them. Note that for some links inclusion depends on the status of the payment (e.g. cancel link will be available on PENDING and refund on SUCCEEDED)

  - `_links.self` (object, required)

  - `_links.self.href` (string, required)

  - `_links.deeplink` (object, required)

  - `_links.qrcode` (object, required)

  - `_links.cancel` (object)

  - `_links.refund` (object)

  - `_links.checkout` (object)

## Response 401 fields (application/json):

  - `code` (string, required)

  - `message` (string, required)

  - `traceId` (string, required)
    id that is assigned to a single request, job, or action

  - `spanId` (string, required)
    id of the work unit where the error occured

## Response 403 fields (application/json):

  - `code` (string, required)

  - `message` (string, required)

  - `traceId` (string, required)
    id that is assigned to a single request, job, or action

  - `spanId` (string, required)
    id of the work unit where the error occured

## Response 404 fields (application/json):

  - `code` (string, required)

  - `message` (string, required)

  - `traceId` (string, required)
    id that is assigned to a single request, job, or action

  - `spanId` (string, required)
    id of the work unit where the error occured

## Response 500 fields (application/json):

  - `code` (string, required)

  - `message` (string, required)

  - `traceId` (string, required)
    id that is assigned to a single request, job, or action

  - `spanId` (string, required)
    id of the work unit where the error occured