{
"eventId": "<string>",
"eventType": "PAYMENT_COMPLETED",
"data": {
"payment": {
"id": "<string>",
"amount": 123,
"currency": "<string>",
"paymentTime": "2023-11-07T05:31:56Z",
"type": "<string>",
"authorizationCode": "<string>",
"cardDetail": {
"id": "<string>",
"cardholder": "<string>",
"last4": "<string>",
"brand": "<string>",
"expiryMonth": 123,
"expiryYear": 123,
"funding": "<string>",
"issuer": "<string>",
"country": "<string>"
},
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"meta": {}
},
"items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"quantity": 123,
"conceptId": "<string>",
"concept": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"amount": 123,
"currency": "<string>",
"displayName": "<string>",
"description": "<string>",
"sku": "<string>",
"organizationId": "<string>",
"active": true,
"recurrentDetailId": "<string>",
"amountEditable": true,
"quantityEditable": true,
"archivedAt": "2023-11-07T05:31:56Z",
"archivedById": "<string>",
"oneOff": true,
"groupId": "<string>",
"createdById": "<string>",
"updatedById": "<string>",
"group": {
"id": "<string>",
"name": "<string>"
},
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"meta": {}
}
}
],
"relatedInvoices": [
{
"id": "<string>",
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"meta": {},
"items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"quantity": 123,
"conceptId": "<string>",
"concept": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"amount": 123,
"currency": "<string>",
"displayName": "<string>",
"description": "<string>",
"sku": "<string>",
"organizationId": "<string>",
"active": true,
"recurrentDetailId": "<string>",
"amountEditable": true,
"quantityEditable": true,
"archivedAt": "2023-11-07T05:31:56Z",
"archivedById": "<string>",
"oneOff": true,
"groupId": "<string>",
"createdById": "<string>",
"updatedById": "<string>",
"group": {
"id": "<string>",
"name": "<string>"
},
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"meta": {}
}
}
]
}
],
"paymentAttempt": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"success": true,
"startedOn": "<string>",
"automatic": true,
"scheduled": true,
"wasAttemptedByOrganization": true,
"attemptNumber": 123,
"errorCode": "<string>",
"errorType": "<string>",
"errorResponse": "<string>"
},
"customer": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"username": "<string>",
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"meta": {}
},
"paymentSession": {
"id": "<string>",
"returnUrl": "<string>",
"cancelUrl": "<string>",
"totalAmount": 123,
"currency": "<string>",
"status": "<string>",
"displayMode": "<string>",
"origin": "<string>",
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"meta": {}
}
}
}Webhooks
Pago completado
Payload enviado cuando un pago termina de procesarse.
WEBHOOK
paymentCompleted
{
"eventId": "<string>",
"eventType": "PAYMENT_COMPLETED",
"data": {
"payment": {
"id": "<string>",
"amount": 123,
"currency": "<string>",
"paymentTime": "2023-11-07T05:31:56Z",
"type": "<string>",
"authorizationCode": "<string>",
"cardDetail": {
"id": "<string>",
"cardholder": "<string>",
"last4": "<string>",
"brand": "<string>",
"expiryMonth": 123,
"expiryYear": 123,
"funding": "<string>",
"issuer": "<string>",
"country": "<string>"
},
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"meta": {}
},
"items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"quantity": 123,
"conceptId": "<string>",
"concept": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"amount": 123,
"currency": "<string>",
"displayName": "<string>",
"description": "<string>",
"sku": "<string>",
"organizationId": "<string>",
"active": true,
"recurrentDetailId": "<string>",
"amountEditable": true,
"quantityEditable": true,
"archivedAt": "2023-11-07T05:31:56Z",
"archivedById": "<string>",
"oneOff": true,
"groupId": "<string>",
"createdById": "<string>",
"updatedById": "<string>",
"group": {
"id": "<string>",
"name": "<string>"
},
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"meta": {}
}
}
],
"relatedInvoices": [
{
"id": "<string>",
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"meta": {},
"items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"quantity": 123,
"conceptId": "<string>",
"concept": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"amount": 123,
"currency": "<string>",
"displayName": "<string>",
"description": "<string>",
"sku": "<string>",
"organizationId": "<string>",
"active": true,
"recurrentDetailId": "<string>",
"amountEditable": true,
"quantityEditable": true,
"archivedAt": "2023-11-07T05:31:56Z",
"archivedById": "<string>",
"oneOff": true,
"groupId": "<string>",
"createdById": "<string>",
"updatedById": "<string>",
"group": {
"id": "<string>",
"name": "<string>"
},
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"meta": {}
}
}
]
}
],
"paymentAttempt": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"success": true,
"startedOn": "<string>",
"automatic": true,
"scheduled": true,
"wasAttemptedByOrganization": true,
"attemptNumber": 123,
"errorCode": "<string>",
"errorType": "<string>",
"errorResponse": "<string>"
},
"customer": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"username": "<string>",
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"meta": {}
},
"paymentSession": {
"id": "<string>",
"returnUrl": "<string>",
"cancelUrl": "<string>",
"totalAmount": 123,
"currency": "<string>",
"status": "<string>",
"displayMode": "<string>",
"origin": "<string>",
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"meta": {}
}
}
}Body
application/json
Response
2XX
Webhook accepted by the receiver.
Was this page helpful?