Skip to main content
GET
Get payment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payment
string
required

The unique identifier of the payment.

Example:

"zrj3pok3ikbx"

store
string
required

The unique identifier of the store.

Example:

"waxhsjr47zsl"

Response

200 - application/json

Successfully fetched payment.

amountCents
number
required

Amount in cents

Required range: x >= 1000000
Example:

5000000

currencyCode
string
required

Currency code

Example:

"COP"

title
string
required

Payment title

Example:

"Juguete"

description
string
required

Payment description (at least 24 characters)

Example:

"Juguete increíble"

buyer
object
required
name
string
required

Payment's resource name

Example:

"stores/01JNRRDZDPH40DB2YRW329BFXM/payments/01JNRVWWHH68E76V3TMFFT6GHJ"

status
enum<string>
required

Payment status

Available options:
STATUS_UNSPECIFIED,
AWAITING_PAYMENT,
PAYMENT_IN_PROGRESS,
FUNDED,
DELIVERING,
UNDER_REVIEW,
APPROVED,
DISPUTED,
REFUNDED,
EXPIRED,
CANCELED,
FAILED
Example:

"AWAITING_PAYMENT"

organization
string
required

Organization's resource name

Example:

"organizations/01JNRR1NY8MDX4XCGG0N4F06X3"

url
string
required

Payment link

Example:

"https://checkout.confiopagos.com/p/01JNV8CSHNN933B09T5MTNK89V"

createTime
string
required

Creation timestamp

Example:

"2024-01-15T10:30:00Z"

updateTime
string
required

Last update timestamp

Example:

"2024-01-15T10:30:00Z"

expireTime
string
required

Payment expiration timestamp

Example:

"2024-01-18T10:30:00Z"

correlationId
string

Your internal payment/order ID for tracking and correlation. Use this to match Confío payments with your system's orders.

Example:

"36285414"

mediaAssets
string<uri>[]

Media assets links (required when paymentType is PRODUCT, max 6 items). Each URL must be a publicly accessible URL from a public server (e.g., your CDN, cloud storage, or any public web server). Allowed formats: PNG, JPEG, JPEG XL, WebP, AVIF, GIF, ICO, SVG, HEIC, BMP, TIFF. Maximum file size: 100MB per file.

Maximum array length: 6
Example:
enabledPaymentMethods
enum<string>[]

Optional list of payment methods to enable for this payment. If omitted, all available methods are shown.

Available options:
PSE,
CARD,
BANCOLOMBIA,
NEQUI
Example:
paymentType
enum<string>
default:PRODUCT

Payment type: 'PRODUCT' or 'SERVICE', default is 'PRODUCT'

Available options:
PRODUCT,
SERVICE
Example:

"PRODUCT"

redirectUri
string<uri>

Redirect URI after payment creation

Example:

"https://example.com/payment-status"

courier
string

Name of the courier service used for delivery (optional)

Example:

"Coordinadora"

trackingNumber
string

Courier tracking number for delivery (optional)

Example:

"453265"

disableBuyerNotification
boolean
default:false

Disable WhatsApp notification to buyer on payment creation. By default, a notification is sent to the buyer's WhatsApp when a payment is created. Set to true to disable this notification.

Example:

false

discountPercentage
number

Discount percentage applied to the payment as decimal (0-1, e.g., 0.35 for 35%).

Required range: 0 <= x <= 1
Example:

0.1

discountSource
string

The source of the discount (e.g., 'ty_page_cod_conversion', 'promo_code', 'referral')

Example:

"ty_page_cod_conversion"