Ejemplos de consumo de las APIs

Esta sección presenta ejemplos de cómo consumir las APIs de pago de la plataforma de Redeban para los procesos de iniciación de pagos. Cada paso incluye la solicitud, sus parámetros y la respuesta esperada.

📘
Prerrequisitos que se deben cumplir antes de invocar las APIs

El participante debe estar registrado en la plataforma y contar con los certificados de red (network) y de firma (signing) emitidos por el Directorio de Participantes de Open Banking de Redeban.
Debe disponer del identificador Client ID entregado tras el registro (DCR).
Debe usar el certificado de red para conectarse a todos los endpoints mediante mTLS, y el certificado de firma para firmar el payload de cada endpoint POST con el header x-jws-signature.

📘
Sobre los ejemplos
Para facilitar la lectura, los valores largos (JWT, certificados, firmas DPoP y x-jws-signature) aparecen truncados con la marca …‹truncado›. En las solicitudes reales se debe enviar el valor completo generado por las llaves y certificados del participante. Estos valores pueden generarse con el utilitario PPS.

1. Configurar las credenciales del token de acceso

Esta solicitud usa el flujo client credentials (CCG) de OAuth 2.0 para obtener un token de acceso.

Solicitud

curl --location 'https://api.stage.redebanopenfinance.com/0051/token.oauth2/v1' \
--key ./{network.key} \
--cert ./{network.pem} \
--header 'DPoP: eyJ0eXAiOiJkcG9wK2p3dCIsImFsZyI6IlBTMjU2…‹truncado›' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=SC-2b265e7b-ed19-4309-84de-b96cf7d2d483' \
--data-urlencode 'client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer' \
--data-urlencode 'client_assertion=eyJhbGciOiJQUzI1NiIsImtpZCI6Ik5iMDhpWlZ6…‹truncado›' \
--data-urlencode 'scope=payments'

Parámetros

Parámetro	Valor ejemplo	Descripción
`grant_type`	`client_credentials`	Tipo de autorización (grant type) solicitado.
`Bank` (en la ruta)	`0051`	Identificador del banco proveedor.
`scope`	`payments`	scope genérico para operaciones de pago. Especifica los datos y permisos que el TPP solicita al banco.
`client_id`	`SC-2b265e7b-…`	TPP registrado en la plataforma de Redeban.
`client_assertion_type`	`urn:ietf:params:oauth:client-assertion-type:jwt-bearer`	Tipo de afirmación estándar de OAuth 2.0.
`client_assertion`	(JWT firmado)	client_assertion para el método `private_key_jwt`. Ver Client Assertion.
`DPoP`	(JWT de prueba)	DPoP. Ver DPoP.

Respuesta

{
    "access_token": "2YDTb98f14kP91Z-3jOk1gFkhPp4iY8WysujkakaTUc",
    "token_type": "DPoP",
    "expires_in": 3600,
    "scope": "payments"
}

El access_token obtenido en la respuesta será empleado en la API para la creación del consentimiento y tiene un tiempo de vida de 3600 segundos o en su defecto 1 hora.

2. Configurar la solicitud de consentimiento de la orden de pago

API que el TPP invoca para crear el consentimiento de una orden de pago, mediante un POST al endpoint /{BANK}/domestic-payment-consents/v1. Permite registrar en la plataforma de Redeban una copia del consentimiento establecido entre el cliente y el TPP, para que el cliente lo autorice posteriormente.

Tras crear el consentimiento correctamente, el Consent ID generado permite consultar su estado mediante GET /{BANK}/domestic-payment-consents/v1/{CONSENTID}.

Esta API requiere un token de acceso obtenido mediante CCG, como en el paso anterior, este token debe ir en un header de la siguiente forma (Authorization: DPoP <access_token>).

Existen dos tipos de consentimientos que se pueden crear: el consentimiento implícito y el consentimiento explícito.

Solicitud (creación del consentimiento)

curl --location 'https://api.stage.redebanopenfinance.com/0051/domestic-payment-consents/v1' \
--header 'Content-Type: application/json' \
--header 'Authorization: DPoP KLUP74YOE_tbFfi6iCAEhMQnxnIKrZzxOEQYmLon-Mc' \
--header 'x-idempotency-key: 3' \
--header 'x-jws-signature: eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6…‹truncado›' \
--header 'DPoP: eyJ0eXAiOiJkcG9wK2p3dCIsImFsZyI6IlBTMjU2…‹truncado›' \
--data '{"Data":{"ReadRefundAccount":"Yes","Authorisation":{"AuthorisationType":"Any","CompletionDateTime":"2025-11-12T00:00:00+00:00"},"Initiation":{"InstructionIdentification":"0555ca8f-bca6-470e-a192-2e897578a30","EndToEndIdentification":"DEMO USER","InstructedAmount":{"Amount":"115.00","Currency":"COP"},"CreditorAccount":{"SchemeName":"CAHO","Identification":"0036024594","Name":"Test user","SecondaryIdentification":"MERCHANTID"},"DebtorAccount":{"SchemeName":"CAHO","Identification":"3559898989","Name":"JESSICA","SecondaryIdentification":"1001017"},"CreditorPostalAddress":{"AddressLine":["test"],"AddressType":"Business","BuildingNumber":"27","Country":"GB","CountrySubDivision":"Wessex","Department":"test","PostCode":"7U31 2ZZ","StreetName":"AcaciaAvenue","SubDepartment":"test sub","TownName":"Sparsholt"},"SupplementaryData":{"DebtorMobileNumber":"3138745276"},"RemittanceInformation":{"Unstructured":"Internal ops code 5120101","Reference":"FRESCO-101"}},"SCASupportData":{"RequestedSCAExemptionType":"BillPayment","AppliedAuthenticationApproach":"CA","ReferencePaymentOrderId":"test"}},"Risk":{"PaymentContextCode":"Other","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"AcaciaAvenue","BuildingNumber":"27","PostCode":"7U31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}}}'

🚧
Tener en cuenta:
En este caso se está creando un consentimiento implícito.

Respuesta (creación del consentimiento)

{
  "Data": {
    "ConsentId": "34830376-9150-40d8-a12a-6019a296687f",
    "CreationDateTime": "2025-08-01T07:03:04+00:00",
    "Status": "AwaitingAuthorisation",
    "StatusUpdateDateTime": "2025-08-01T07:03:04+00:00",
    "ReadRefundAccount": "Yes",
    "Initiation": {
      "InstructionIdentification": "0555ca8f-bca6-470e-a192-2e897578a30",
      "EndToEndIdentification": "DEMO USER",
      "InstructedAmount": {
        "Amount": "115.00",
        "Currency": "COP"
      },
      "DebtorAccount": {
        "SchemeName": "CAHO",
        "Identification": "3559898989",
        "SecondaryIdentification": "1001017"
      },
      "CreditorAccount": {
        "SchemeName": "CAHO",
        "Identification": "0036024594",
        "Name": "Test user",
        "SecondaryIdentification": "MERCHANTID"
      },
      "RemittanceInformation": {
        "Unstructured": "Internal ops code 5120101",
        "Reference": "FRESCO-101"
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-11-12T00:00:00+00:00"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "test"
    }
  },
  "Risk": {
    "PaymentContextCode": "Other",
    "MerchantCategoryCode": "5967",
    "MerchantCustomerIdentification": "053598653254",
    "DeliveryAddress": {
      "AddressLine": [
        "Flat 7",
        "Acacia Lodge"
      ],
      "StreetName": "AcaciaAvenue",
      "BuildingNumber": "27",
      "PostCode": "7U31 2ZZ",
      "TownName": "Sparsholt",
      "CountrySubDivision": "Wessex",
      "Country": "GB"
    }
  },
  "Links": {
    "Self": "https://api.stage.redebanopenfinance.com/0051/domestic-payment-consents/v1/34830376-9150-40d8-a12a-6019a296687f"
  },
  "Meta": {}
}

Solicitud (obtención del consentimiento)

El endpoint de consentimiento de pago permite a bancos y TPP acceder y verificar de forma segura los detalles y el estado del consentimiento de un usuario. Al validar monto, beneficiario y estado del consentimiento, refuerza la protección al cliente y el cumplimiento normativo.

curl --location 'https://api.stage.redebanopenfinance.com/0051/domestic-payment-consents/v1/77ceb64f-0d53-473d-bcb1-2041fbc8f202' \
--header 'Content-Type: application/json' \
--header 'Authorization: DPoP KLUP74YOE_tbFfi6iCAEhMQnxnIKrZzxOEQYmLon-Mc' \
--header 'DPoP: eyJ0eXAiOiJkcG9wK2p3dCIsImFsZyI6IlBTMjU2…‹truncado›'

Respuesta (obtención del consentimiento)

{
  "Data": {
    "ConsentId": "6b9c764d-42bc-4aed-99eb-c0bd643d54d2",
    "CreationDateTime": "2025-08-01T07:45:36+00:00",
    "Status": "AwaitingAuthorisation",
    "StatusUpdateDateTime": "2025-08-01T07:45:36+00:00",
    "Initiation": {
      "InstructedAmount": {
        "Amount": "115.00",
        "Currency": "COP"
      },
      "CreditorAccount": {
        "SchemeName": "CAHO",
        "Identification": "0036024594",
        "Name": "Test user",
        "SecondaryIdentification": "MERCHANTID"
      },
      "RemittanceInformation": {
        "Unstructured": "Internal ops code 5120101",
        "Reference": "FRESCO-101"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "Other",
    "MerchantCategoryCode": "5967",
    "MerchantCustomerIdentification": "053598653254",
    "DeliveryAddress": {
      "AddressLine": [
        "Flat 7",
        "Acacia Lodge"
      ],
      "StreetName": "AcaciaAvenue",
      "BuildingNumber": "27",
      "PostCode": "7U31 2ZZ",
      "TownName": "Sparsholt",
      "CountrySubDivision": "Wessex",
      "Country": "GB"
    }
  },
  "Links": {
    "Self": "https://api.stage.redebanopenfinance.com/0051/domestic-payment-consents/v1"
  },
  "Meta": {}
}

Encabezados

Parámetro	Descripción
`DPoP`	DPoP. Ver DPoP.
`Authorization`	En FAPI 2.0 con DPoP, el encabezado de autorización usa el formato `DPoP <access_token>`.

📘
Los posibles valores de Status y su significado se detallan en Domestic Payment Consent APIs y en Códigos de error.

3. Autorizar el consentimiento de la orden de pago

Con el Consent ID obtenido, el TPP crea una solicitud de autorización para que el cliente otorgue el consentimiento sobre la instrucción de pago. Este flujo usa el código de autorización (ACG) de OAuth 2.0.

Conforme a FAPI 2.0, el TPP primero envía una solicitud PAR a la plataforma de Redeban para obtener un request_uri, que se usará en la solicitud de autorización.

Solicitud (PAR)

curl --location 'https://api.stage.redebanopenfinance.com/0051/par.oauth2/v1' \
--key ./{network.key} \
--cert ./{network.pem} \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=SC-2b265e7b-ed19-4309-84de-b96cf7d2d483' \
--data-urlencode 'response_type=code' \
--data-urlencode 'redirect_uri=https://www.saucedemo.com' \
--data-urlencode 'client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer' \
--data-urlencode 'client_assertion=eyJhbGciOiJQUzI1NiIsImtpZCI6Ik5iMDhpWlZ6…‹truncado›' \
--data-urlencode 'code_challenge_method=S256' \
--data-urlencode 'code_challenge=r2v8uBRgt09c56pf05Fg4qo5p2IT22XrOCCONda_9rw' \
--data-urlencode 'consent_id=77ceb64f-0d53-473d-bcb1-2041fbc8f202' \
--data-urlencode 'scope=payments'

Parámetros

Parámetro	Valor ejemplo	Descripción
`scope`	`payments`	scope genérico para operaciones de pago.
`Banco` (en la ruta)	`0051`	Identificador del banco proveedor.
`client_id`	`SC-2b265e7b-…`	ID de cliente del TPP, en formato `SC-<UUID>`.
`response_type`	`code`	Usado en OAuth 2.0/OpenID para el flujo de código de autorización.
`redirect_uri`	(URL del TPP)	URL a la que Redeban envía el código de autorización tras una SCA/Consent exitosa.
`client_assertion_type`	`urn:ietf:params:oauth:client-assertion-type:jwt-bearer`	Tipo de afirmación estándar de OAuth.
`client_assertion`	(JWT firmado)	Método `private_key_jwt`. Ver Client Assertion.
`code_challenge_method`	`S256`	Algoritmo del PKCE (RFC 7636).
`code_challenge`	(generado por el TPP)	Valor del `code_challenge` requerido para PKCE.
`consent_id`	`77ceb64f-…`	Consent ID creado en pasos anteriores.
`state`	(opcional)	Permite asociar el proceso de autorización con un estado de la aplicación del TPP.
`dpop_jkt`	(opcional)	Huella de la clave pública usada para el token DPoP; vincula el código de autorización con el DPoP del TPP.

Respuesta (PAR)

{
    "expires_in": 599,
    "request_uri": "urn:ietf:params:oauth:request_uri:N9-vkA_zslak0mQn-XNWc-F8j9vaJGw42eH8ZJ18xFI"
}

El request_uri obtenido en la respuesta será empleado en el proceso de autenticación y autorización del usuario y tiene un tiempo de vida de 599 segundos o en su defecto alrededor de 10 minutos.

📘
Si la solicitud PAR es exitosa, Redeban devuelve un request_uri único, que se usa para enviar la solicitud de autorización al banco a través de una URL proporcionada por Redeban.

4. Autenticación y autorización del usuario (SCA + consentimiento)

Con el request_uri obtenido, el TPP consume la siguiente URL desde un navegador web para iniciar la SCA y la autorización del consentimiento con el banco, usando el front channel.

Solicitud (front channel, vía navegador)

https://auth.stage.redebanopenfinance.com/0051/authorization.oauth2?client_id=SC-2b265e7b-ed19-4309-84de-b96cf7d2d483&request_uri=urn:ietf:params:oauth:request_uri:d8_RMOtAv3ClZ3omdB67Qaa

Parámetros de la URL

Parámetro	Valor ejemplo	Descripción
`Bank` (en la ruta)	`0051`	Identificador del banco.
`client_id`	`SC-2b265e7b-…`	ID de cliente del TPP, en formato `SC-<UUID>`.
`request_uri`	`urn:ietf:params:oauth:request_uri:…`	Referencia temporal a la solicitud de autorización enviada de forma segura vía PAR, que evita exponer datos sensibles en la URL.

Respuesta (redirección)

Al realizar este consumo mediante el navegador, Redeban redirigirá automáticamente al autenticador del banco para que realice el proceso de SCA. Mientras se lleva a cabo este proceso, el banco debe consumir las APIs del Back Channel, logrando así que el cliente:

Se autentique en la entidad,
Selecciona la cuenta/llave con la cual desea pagar.
Indique si acepta o rechaza el consentimiento
Sea redirigido nuevamente hacia el TPP con el código de autorización (code) en caso de éxito o con el error en caso de alguna excepción.

5. Obtener el token de acceso para consumir las APIs

Una vez finalizada la interacción de la Entidad y sea redirigido el cliente hacia el TPP con el código de autorización en la URL, de la siguiente forma:

https://{URL_redirección}?code=HGdwkztThJ-qd318PZS0xxZ3mY8fQnQIAjMNLc&state=eyJhbGci&iss=https%3A%2F%2Fredebanopenfinance.co

El TPP usa el flujo de código de autorización (ACG) de OAuth 2.0 para obtener un token de acceso con el que puede consumir los demás recursos.

Solicitud

curl --location 'https://api.stage.redebanopenfinance.com/0051/token.oauth2/v1' \
--key ./{network.key} \
--cert ./{network.pem} \
--header 'DPoP: eyJ0eXAiOiJkcG9wK2p3dCIsImFsZyI6IlBTMjU2…‹truncado›' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'code=xYhvRikTWC3-uX01bHCcs4h55orie2kBdngzXZoR9B0' \
--data-urlencode 'grant_type=authorization_code' \
--data-urlencode 'client_id=SC-2b265e7b-ed19-4309-84de-b96cf7d2d483' \
--data-urlencode 'redirect_uri=https://www.saucedemo.com' \
--data-urlencode 'client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer' \
--data-urlencode 'client_assertion=eyJhbGciOiJQUzI1NiIsImtpZCI6Ik5iMDhpWlZ6…‹truncado›' \
--data-urlencode 'code_verifier=c7oXlQkXEjCF_zrepKZCs_U5nUzKUdee-SKJ3hRxOgjow…‹truncado›'

Respuesta

{
    "access_token": "Zq-qThi2wsw1NlVhNF8ShL6qrN8Eihrj2xN1eXE-5V0",
    "token_type": "DPoP",
    "expires_in": 3600,
    "scope": "payments"
}

El access_token obtenido en la respuesta será empleado en la API para el envío del pago y tiene un tiempo de vida de 3600 segundos o en su defecto 1 hora.

Parámetros

Parámetro	Valor ejemplo	Descripción
`grant_type`	`authorization_code`	Tipo de autorización solicitado.
`Bank` (en la ruta)	`0051`	Identificador del banco proveedor.
`DPoP`	(JWT de prueba)	DPoP. Ver DPoP.
`client_id`	`SC-6b867038-…`	TPP registrado en la plataforma de Redeban.
`client_assertion_type`	`urn:ietf:params:oauth:client-assertion-type:jwt-bearer`	Tipo de afirmación estándar de OAuth 2.0.
`client_assertion`	(JWT firmado)	Método `private_key_jwt`. Ver Client Assertion.
`code_verifier`	(cadena aleatoria)	Cadena del PKCE (RFC 7636) que corresponde al `code_challenge` enviado en PAR.
`redirect_uri`	`https://www.saucedemo.com/`	URL a la que el servidor OAuth 2.0 devuelve al usuario tras la autenticación.
`code`	`d3srbzR3mq4o…`	Código de autorización temporal emitido en la ruta de la URL de redirección del TPP tras la autenticación y autorización del usuario.

6. Crear y enviar una orden de pago

El TPP inicia el envío de una orden de pago usando el token ACG obtenido en el paso 5, mediante un POST a /{BANK}/domestic-payments/v1. El cuerpo debe incluir la misma información proporcionada en el consentimiento.

Solicitud

curl --location 'https://api.stage.redebanopenfinance.com/0051/domestic-payments/v1' \
--key ./{network.key} \
--cert ./{network.pem} \
--header 'Content-Type: application/json' \
--header 'Authorization: DPoP 0eAZyHGvptpAlO1brSJrT0x4sr0zZy1nX25O-Uiqz_g' \
--header 'x-fapi-financial-id: 0015800000jfQ9aAAE' \
--header 'x-idempotency-key: 1754286558' \
--header 'x-jws-signature: eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6…‹truncado›' \
--header 'DPoP: eyJ0eXAiOiJkcG9wK2p3dCIsImFsZyI6IlBTMjU2…‹truncado›' \
--data '{"Data":{"ConsentId":"bc51fa51-bf94-4e10-9e8b-fb471a671e0f","Initiation":{"InstructionIdentification":"0555ca8f-bca6-470e-a192-2e897578a30","EndToEndIdentification":"DEMO USER","InstructedAmount":{"Amount":"115.00","Currency":"COP"},"CreditorAccount":{"SchemeName":"CAHO","Identification":"0036024594","Name":"Test user","SecondaryIdentification":"MERCHANTID"},"DebtorAccount":{"SchemeName":"CAHO","Identification":"3559898989","Name":"JESSICA","SecondaryIdentification":"1001017"},"CreditorPostalAddress":{"AddressLine":["test"],"AddressType":"Business","BuildingNumber":"27","Country":"GB","CountrySubDivision":"Wessex","Department":"test","PostCode":"7U31 2ZZ","StreetName":"AcaciaAvenue","SubDepartment":"test sub","TownName":"Sparsholt"},"SupplementaryData":{"DebtorMobileNumber":"3138745276"},"RemittanceInformation":{"Unstructured":"Internal ops code 5120101","Reference":"FRESCO-101"}}},"Risk":{"PaymentContextCode":"Other","MerchantCategoryCode":"5967","MerchantCustomerIdentification":"053598653254","DeliveryAddress":{"AddressLine":["Flat 7","Acacia Lodge"],"StreetName":"AcaciaAvenue","BuildingNumber":"27","PostCode":"7U31 2ZZ","TownName":"Sparsholt","CountrySubDivision":"Wessex","Country":"GB"}}}'

Respuesta (201) cuando el pago se crea y envía

{
  "Data": {
    "DomesticPaymentId": "3859a0f0-e499-497e-8c73-d10e2e51d9d6",
    "ConsentId": "bc51fa51-bf94-4e10-9e8b-fb471a671e0f",
    "CreationDateTime": "2025-08-01T08:13:50+00:00",
    "Status": "AcceptedSettlementInProcess",
    "StatusUpdateDateTime": "2025-08-01T08:14:05+00:00",
    "Refund": {
      "Account": {
        "SchemeName": "CAHO",
        "Identification": "3559898989",
        "Name": "JESSICA",
        "SecondaryIdentification": "1001017"
      }
    },
    "Charges": [
      {
        "Amount": {
          "Amount": "115.00",
          "Currency": "COP"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "0555ca8f-bca6-470e-a192-2e897578a308",
      "EndToEndIdentification": "DEMO USER",
      "InstructedAmount": {
        "Amount": "115.00",
        "Currency": "COP"
      },
      "DebtorAccount": {
        "SchemeName": "CAHO",
        "Identification": "3559898989",
        "SecondaryIdentification": "1001017"
      },
      "CreditorAccount": {
        "SchemeName": "CAHO",
        "Identification": "0036024594",
        "Name": "Test user",
        "SecondaryIdentification": "MERCHANTID"
      },
      "RemittanceInformation": {
        "Unstructured": "Internal ops code 5120101",
        "Reference": "FRESCO-101"
      }
    }
  },
  "Links": {
    "Self": "https://api.stage.redebanopenfinance.com/0051/domestic-payments/v1/3859a0f0-e499-497e-8c73-d10e2e51d9d6"
  },
  "Meta": {}
}

x-idempotency-key — Encabezado HTTP que garantiza que una operación se procese una sola vez, aunque la solicitud se reenvíe. Usa un valor único por solicitud (normalmente un UUID).

📘
Para más información sobre los headers y campos de la API, ver la sección específica de cada recurso.

8. Obtener el pago

El TPP puede obtener el estado actual de una orden de pago enviada mediante GET /{BANK}/domestic-payments/v1/{DOMESTICPAYMENTID}.

Solicitud

curl --location 'https://api.stage.redebanopenfinance.com/0051/domestic-payments/v1/3859a0f0-e499-497e-8c73-d10e2e51d9d6' \
--key ./{network.key} \
--cert ./{network.pem} \
--header 'Content-Type: application/json' \
--header 'DPoP: eyJ0eXAiOiJkcG9wK2p3dCIsImFsZyI6IlBTMjU2…‹truncado›' \
--header 'Authorization: DPoP {{CCG_Token}}'

Respuesta (200) cuando se encuentra el pago

{
  "Data": {
    "DomesticPaymentId": "3859a0f0-e499-497e-8c73-d10e2e51d9d6",
    "ConsentId": "bc51fa51-bf94-4e10-9e8b-fb471a671e0f",
    "CreationDateTime": "2025-08-01T08:13:50+00:00",
    "Status": "Rejected",
    "StatusUpdateDateTime": "2025-08-01",
    "Charges": [
      {
        "Amount": {
          "Amount": "115.00",
          "Currency": "COP"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "0555ca8f-bca6-470e-a192-2e897578a30",
      "EndToEndIdentification": "DEMO USER",
      "InstructedAmount": {
        "Amount": "115.00",
        "Currency": "COP"
      },
      "DebtorAccount": {
        "SchemeName": "CAHO",
        "Identification": "3559898989",
        "SecondaryIdentification": "1001017"
      },
      "CreditorAccount": {
        "SchemeName": "CAHO",
        "Identification": "0036024594",
        "Name": "Test user",
        "SecondaryIdentification": "MERCHANTID"
      }
    }
  },
  "Links": {
    "Self": "https://api.stage.redebanopenfinance.com/0051/domestic-payments/v1"
  },
  "Meta": {}
}

📘
Los posibles valores de Status y su significado se detallan en Domestic Payments API y en Códigos de error.

Ejemplos de consumo de las APIs

Prerrequisitos que se deben cumplir antes de invocar las APIs

Sobre los ejemplos

1. Configurar las credenciales del token de acceso

2. Configurar la solicitud de consentimiento de la orden de pago

Tener en cuenta:

Los posibles valores de `Status` y su significado se detallan en Domestic Payment Consent APIs y en Códigos de error.

3. Autorizar el consentimiento de la orden de pago

Si la solicitud PAR es exitosa, Redeban devuelve un `request_uri` único, que se usa para enviar la solicitud de autorización al banco a través de una URL proporcionada por Redeban.

4. Autenticación y autorización del usuario (SCA + consentimiento)

5. Obtener el token de acceso para consumir las APIs

6. Crear y enviar una orden de pago

Para más información sobre los headers y campos de la API, ver la sección específica de cada recurso.

8. Obtener el pago

Los posibles valores de `Status` y su significado se detallan en Domestic Payments API y en Códigos de error.

Prerrequisitos que se deben cumplir antes de invocar las APIs

Sobre los ejemplos

1. Configurar las credenciales del token de acceso

2. Configurar la solicitud de consentimiento de la orden de pago

Tener en cuenta:

Los posibles valores de Status y su significado se detallan en Domestic Payment Consent APIs y en Códigos de error.

3. Autorizar el consentimiento de la orden de pago

Si la solicitud PAR es exitosa, Redeban devuelve un request_uri único, que se usa para enviar la solicitud de autorización al banco a través de una URL proporcionada por Redeban.

4. Autenticación y autorización del usuario (SCA + consentimiento)

5. Obtener el token de acceso para consumir las APIs

6. Crear y enviar una orden de pago

Para más información sobre los headers y campos de la API, ver la sección específica de cada recurso.

8. Obtener el pago

Los posibles valores de Status y su significado se detallan en Domestic Payments API y en Códigos de error.

Los posibles valores de `Status` y su significado se detallan en Domestic Payment Consent APIs y en Códigos de error.

Si la solicitud PAR es exitosa, Redeban devuelve un `request_uri` único, que se usa para enviar la solicitud de autorización al banco a través de una URL proporcionada por Redeban.

Los posibles valores de `Status` y su significado se detallan en Domestic Payments API y en Códigos de error.