conomy_hq
  1. Payments
conomy_hq
  • Quickstart
    • Introduction
    • Obtain an Access Token
    • Create an Organization
    • Create users
    • Create accounts
    • Create your first top-up
    • Create your first withdrawal
    • Create your first purchase
    • Create your first p2p payment
    • Create your first collect payment
    • Supported Identity Document Types
  • Payments
    • Transaction types
    • Transaction status
    • Origins and Destinations
    • Creating a payment
    • Add & remove Fees
  • API reference
    • Auth
      • Auth
    • Identities
      • Create Identity
      • Get Identity
      • Update Identity
      • Delete Identity
      • Get Identities List
      • Add Child to Identity Children
      • Remove Child from Children
      • Add Rule to Identity
      • Remove Rule to Identity
    • Accounts
      • Create Account
      • Get Account
      • Update Account
      • Delete Account
      • Get multiple accounts
    • Payment-methods
      • Get payment-origins
      • Get payment-destinations
    • Payment-attempts
      • Create Attempt
      • Get payment-attempts list
      • Get payment-attempt
    • Payments
      • Create Payment
        POST
      • Authorize Payment
        POST
      • Capture Payment
        POST
      • Get Payment List
        GET
      • Get Payment List paginated
        GET
      • Get Payment
        GET
      • Receive Payment Provider Notification
        POST
      • Client Transaction's Notification Webhook
        POST
  1. Payments

Receive Payment Provider Notification

POST
payments/received
Indicates that the funds have been received and are available in the destination account. This represents the final stage of the payment process, where the funds are no longer in transit and can be used.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'payments/received' \
--header 'x-api-key;' \
--header 'User-Agent;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "YNgma4fqAjwIftRM5Za6D"
}'
Response Response Example
{
  "id": "string",
  "externalId": "string",
  "identityId": "string",
  "identityExternalId": "string",
  "accountNumber": "string",
  "totalAmount": "string",
  "currency": "string",
  "description": "string",
  "product": "string",
  "status": "string",
  "type": "string",
  "purchaseAmount": "string",
  "purchaseCurrency": "string",
  "fees": [
    {
      "Name": "string",
      "Type": "string",
      "Value": "string"
    }
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "expiresAt": "string",
  "capturedAt": "string",
  "authorizedAt": "string",
  "refundedAt": "string",
  "origins": [
    {
      "externalId": "string",
      "name": "string",
      "type": "string",
      "amount": "string",
      "currency": "string",
      "settlement": "string",
      "fee": {
        "name": "string",
        "type": "string",
        "value": "string",
        "currency": "string"
      },
      "identity": {
        "name": "string",
        "documentNumber": "string",
        "externalId": "string",
        "lastname": "string"
      },
      "bank": {
        "accountNumber": "string",
        "bank": "string",
        "currency": "string",
        "typeAccount": "string",
        "accountHolder": "string",
        "accountHolderDni": "string",
        "country": "string"
      },
      "account": {
        "id": "string",
        "identityId": "string",
        "externalId": "string",
        "type": "string",
        "currency": "string",
        "accountNumber": "string",
        "accountHolder": "string",
        "custodyBankAccount": {
          "accountNumber": "string",
          "bank": "string",
          "currency": "string",
          "typeAccount": "string",
          "country": "string"
        }
      },
      "paymentInitiation": {
        "type": "string",
        "origin": "string",
        "referenceId": "string",
        "description": {
          "title": "string",
          "icon": "string",
          "color": "string"
        },
        "url": "string",
        "token": "string",
        "minimumAmount": "string",
        "maximumAmount": "string"
      },
      "card": {
        "type": "string",
        "origin": "string",
        "referenceId": "string",
        "description": {
          "title": "string",
          "icon": "string",
          "color": "string"
        },
        "url": "string",
        "token": "string",
        "minimumAmount": "string",
        "maximumAmount": "string"
      },
      "metadata": {
        "image": "string",
        "description": "string",
        "category": "string"
      },
      "paymentLink": {
        "expiredAt": "string",
        "name": "string",
        "metadata": {
          "description": "string"
        },
        "paymentMethods": [
          "string"
        ],
        "payer": {
          "name": "string",
          "email": "string"
        },
        "provider": "string"
      }
    }
  ],
  "destinations": [
    {
      "externalId": "string",
      "name": "string",
      "type": "string",
      "amount": "string",
      "currency": "string",
      "settlement": "string",
      "fee": {
        "name": "string",
        "type": "string",
        "value": "string",
        "currency": "string"
      },
      "identity": {
        "name": "string",
        "documentNumber": "string",
        "externalId": "string",
        "lastname": "string"
      },
      "bank": {
        "accountNumber": "string",
        "bank": "string",
        "currency": "string",
        "typeAccount": "string",
        "accountHolder": "string",
        "accountHolderDni": "string",
        "country": "string"
      },
      "account": {
        "id": "string",
        "identityId": "string",
        "externalId": "string",
        "type": "string",
        "currency": "string",
        "accountNumber": "string",
        "accountHolder": "string",
        "custodyBankAccount": {
          "accountNumber": "string",
          "bank": "string",
          "currency": "string",
          "typeAccount": "string",
          "country": "string"
        }
      },
      "paymentInitiation": {
        "type": "string",
        "origin": "string",
        "referenceId": "string",
        "description": {
          "title": "string",
          "icon": "string",
          "color": "string"
        },
        "url": "string",
        "token": "string",
        "minimumAmount": "string",
        "maximumAmount": "string"
      },
      "card": {
        "type": "string",
        "origin": "string",
        "referenceId": "string",
        "description": {
          "title": "string",
          "icon": "string",
          "color": "string"
        },
        "url": "string",
        "token": "string",
        "minimumAmount": "string",
        "maximumAmount": "string"
      },
      "metadata": {
        "image": "string",
        "description": "string",
        "category": "string"
      },
      "paymentLink": {
        "expiredAt": "string",
        "name": "string",
        "metadata": {
          "description": "string"
        },
        "paymentMethods": [
          "string"
        ],
        "payer": {
          "name": "string",
          "email": "string"
        },
        "provider": "string"
      }
    }
  ],
  "settlement": "string"
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
x-api-key
string 
required
User-Agent
string 
required
Body Params application/json
transactionId
string 
required
transaction id
signature
string 
required
provider signature
Examples

Responses

🟢200Success
application/json
Body
Schema representing a financial transaction, including details about the transaction's origins, destinations, amounts, fees, and status.
id
string 
required
Unique identifier for the transaction.
externalId
string 
required
External reference identifier for integrations.
identityId
string 
required
Identifier linking the transaction to a specific user or organization.
identityExternalId
string 
optional
External reference identifier for the identity associated with the transaction.
accountNumber
string 
required
The account number involved in the transaction.
totalAmount
string 
required
The total amount of the transaction.
currency
string 
required
The currency used in the transaction. USD, EUR, CLP, ARS, COP, PER, SOL_USDC
description
string 
optional
A brief description of the transaction.
product
string 
optional
The product or service related to the transaction. purchaseCurrency:Currency
status
string 
required
The current status of the transaction (e.g., PENDING, AUTHORIZED, CAPTURED, ATTEMPT, REFUNDED).
type
string 
required
The type of transaction (e.g., payment, refund, transfer).
purchaseAmount
string 
optional
The amount paid in the transaction.
purchaseCurrency
string 
optional
The currency used for the purchase amount. USD, EUR, CLP, ARS, COP, PER, SOL_USDC
fees
array [object {3}] 
optional
A list of fees associated with the transaction.
Name
string 
required
The name of the fee.
Type
string 
required
The type of fee applied (e.g., fixed, percentage).
Value
string 
required
The value of the fee applied.
createdAt
string 
required
Timestamp indicating when the transaction was created.
updatedAt
string 
required
Timestamp indicating the last update to the transaction.
expiresAt
string 
optional
Timestamp indicating when the transaction expires, if applicable.
capturedAt
string 
optional
Timestamp indicating when the transaction was captured.
authorizedAt
string 
optional
Timestamp indicating when the transaction was authorized.
refundedAt
string 
optional
Timestamp indicating when the transaction was refunded, if applicable.
origins
array[object (Payment) {14}] 
optional
A list of sources for the transaction.
externalId
string 
optional
External reference identifier for integrations.
name
string 
optional
The name of the source or destination of the transaction.
type
string 
optional
The type of source or destination BANK_ACCOUNT, CRYPTO, CARD, PAYMENT_INITIATION, ACCOUNT
amount
string 
optional
The amount involved in the transaction.
currency
string 
optional
The currency of the transaction (e.g., USD, EUR).
settlement
string 
optional
Indicates the settlement period.
fee
object 
optional
Details about any fees applied to the transaction.
identity
object 
optional
The entity associated with the source or destination.
bank
object 
optional
Details of the bank involved in the transaction.
account
object 
optional
The account associated with the source or destination.
paymentInitiation
object (paymentsMethods) 
optional
Details of a payment initiation, if applicable.
card
object (paymentsMethods) 
optional
Details of a card transaction, if applicable.
metadata
object 
optional
Additional metadata related to the transaction source or destination.
paymentLink
object (paymentLink) 
required
destinations
array[object (Payment) {14}] 
optional
A list of destinations for the transaction.
externalId
string 
optional
External reference identifier for integrations.
name
string 
optional
The name of the source or destination of the transaction.
type
string 
optional
The type of source or destination BANK_ACCOUNT, CRYPTO, CARD, PAYMENT_INITIATION, ACCOUNT
amount
string 
optional
The amount involved in the transaction.
currency
string 
optional
The currency of the transaction (e.g., USD, EUR).
settlement
string 
optional
Indicates the settlement period.
fee
object 
optional
Details about any fees applied to the transaction.
identity
object 
optional
The entity associated with the source or destination.
bank
object 
optional
Details of the bank involved in the transaction.
account
object 
optional
The account associated with the source or destination.
paymentInitiation
object (paymentsMethods) 
optional
Details of a payment initiation, if applicable.
card
object (paymentsMethods) 
optional
Details of a card transaction, if applicable.
metadata
object 
optional
Additional metadata related to the transaction source or destination.
paymentLink
object (paymentLink) 
required
settlement
string 
optional
Settlement period for the transaction.
Modified at 2025-04-23 19:22:44
Previous
Get Payment
Next
Client Transaction's Notification Webhook
Built with