Consignments – Consult Remittance

Consignments – Consult Remittance 1.1.2

Remittances

API que permite consultar el estado de la remesa.

expand_moreexpand_lessContact information
Bancolombia API Working Group
  • Protocols: HTTPS
production
development
https://sbapi.bancolombia.com

Base Gateway API Endpoint

Paths

/remittances/{payments_orderReference}

get /remittances/{payments_orderReference}
Remittances

Consultar el estado de una remesa.

Esta operación permite consultar la información general de la remesa, así como su estado actual.

OAuth - Provider from OTP Pymes - Flow Application
OAuth - Provider from OTP Pymes - Flow Application
(oauth2 application)

Proveedor de OAuth para autenticación con One Time Password(OTP) para Pymes

Token URL
https://api.us.apiconnect.ibmcloud.com/bancolombiabluemix-dev/sandbox/v1/security/oauth-otp-pymes/oauth2/token
Scopes
Remittance-payment:read:app
Consulta de pagos de remesas.
payments_orderReference
Required in path
string

payment order reference.

payments_orderValueAmount
Required in query
number / float

Valor de la orden de pago.

currency_rate
Required in query
number / float

Tasa de cambio de dólar a peso colombiano.

Accept
Optional in header
string
application/vnd.bancolombia.v1+json
200

Successful response.

responseBody
400

Error in the request.

failure
401

Incorrect credentials.

failure
403

You do not have permissions to access the resource.

failure
404

Resource not found.

failure
409

Resource state has conflicts with data of the request.

failure
500

Internal server error.

failure
502

Error in the service provider response.

failure
503

Service unavailable.

failure
504

Service provider response time exceeded.

failure
default

Unexpected Error.

Example Request
Example Response
GET https://sbapi.bancolombia.com/v1/operations/specific-product/consumer-services/remittances/{payments_orderReference}
Try this operation
https://sbapi.bancolombia.com/v1/operations/specific-product/consumer-services/remittances/{payments_orderReference}
accept
payments_orderReference
payments_orderValueAmount
currency_rate
head /remittances/{payments_orderReference}
Remittances
payments_orderReference
Required in path
string

payment order reference.

Accept
Optional in header
string
application/vnd.bancolombia.v1+json
200

200 OK

Example Request
Example Response
HEAD https://sbapi.bancolombia.com/v1/operations/specific-product/consumer-services/remittances/{payments_orderReference}
Try this operation
https://sbapi.bancolombia.com/v1/operations/specific-product/consumer-services/remittances/{payments_orderReference}
accept
payments_orderReference

Definitions 

{
    "type": "object",
    "required": [
        "meta",
        "data"
    ],
    "properties": {
        "meta": {
            "$ref": "#\/definitions\/meta"
        },
        "data": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "object",
                "required": [
                    "header",
                    "status",
                    "agreement_number",
                    "paymentOrder"
                ],
                "properties": {
                    "header": {
                        "$ref": "#\/definitions\/headerData"
                    },
                    "status": {
                        "type": "object",
                        "required": [
                            "code",
                            "description"
                        ],
                        "properties": {
                            "code": {
                                "type": "string",
                                "description": "Código de estado de la remesa",
                                "example": "04"
                            },
                            "description": {
                                "type": "string",
                                "description": "Descripción del estado de la remesa",
                                "example": "Pendiente"
                            }
                        }
                    },
                    "agreement_number": {
                        "type": "string",
                        "description": "Código de convenio",
                        "example": "123",
                        "maxLength": 3
                    },
                    "paymentOrder": {
                        "$ref": "#\/definitions\/paymentOrder"
                    }
                }
            }
        },
        "links": {
            "$ref": "#\/definitions\/topLevelLinks"
        }
    },
    "additionalProperties": false
}
              
{
    "type": "object",
    "required": [
        "payments_orderReference",
        "payments_orderDate",
        "payments_orderValueAmount",
        "customer_documentType",
        "customer_documentNumber"
    ],
    "properties": {
        "payments_orderReference": {
            "type": "string",
            "description": "Referencia de la orden de pago.",
            "example": "000123455"
        },
        "payments_orderDate": {
            "type": "string",
            "format": "date",
            "description": "fecha en la cual se recibe la orden de pago.",
            "example": "2018-08-23"
        },
        "payments_orderValueAmount": {
            "type": "number",
            "format": "float",
            "description": "Valor de la orden de pago.",
            "example": 100
        },
        "customer_documentType": {
            "type": "string",
            "description": "Tipo de identificación del beneficiario.",
            "example": "CC",
            "enum": [
                "CC",
                "CE",
                "NIT",
                "TI",
                "PAS",
                "IEPJ"
            ]
        },
        "customer_documentNumber": {
            "type": "string",
            "description": "Número de documento del beneficiario.",
            "example": "12345678"
        },
        "payments_hour": {
            "type": "string",
            "description": "Hora de pago de la remesa.",
            "example": "13:00:00"
        },
        "branchOffice_id": {
            "type": "string",
            "description": "Código de la sucursal donde se pagó la remesa.",
            "example": "00245"
        },
        "branchOffice_name": {
            "type": "string",
            "description": "Nombre de la sucursal donde se pagó la remesa.",
            "example": "PUERTA DEL RIO"
        },
        "branchOffice_address": {
            "type": "string",
            "description": "Dirección de la sucursal donde se pagó la remesa.",
            "example": "CARRERA 48 N° 26 - 85"
        },
        "payments_country": {
            "type": "string",
            "description": "País donde se paga la remesa.",
            "example": "Colombia"
        },
        "payments_orderStatus": {
            "type": "array",
            "description": "Descripcion del estado de la remesa según causal.",
            "items": {
                "type": "object",
                "properties": {
                    "payments_orderStatusCode": {
                        "type": "string",
                        "description": "Código del estado de la remesa según causal.",
                        "example": "041"
                    },
                    "payments_orderStatusReason": {
                        "type": "string",
                        "description": "Descripción de estado de la remesa según causal",
                        "example": "Beneficiario cliente no objetivo. Pendiente investigacion"
                    }
                }
            }
        }
    }
}

Meta-información no estándar que no se puede representar con datos.

{
    "type": "object",
    "required": [
        "_messageId",
        "_version",
        "_requestDate"
    ],
    "properties": {
        "_messageId": {
            "type": "string",
            "example": "c4e6bd04-5149-11e7-b114-b2f933d5fe66"
        },
        "_version": {
            "type": "string",
            "example": "1.0"
        },
        "_requestDate": {
            "type": "string",
            "format": "date-time",
            "example": "2017-01-24T05:00:00.000Z"
        },
        "_responseSize": {
            "type": "integer",
            "example": 1
        },
        "_clientRequest": {
            "type": "string",
            "example": "acxff62e-6f12-42de-9012-3e7304418abd"
        }
    }
}

El "type" y "id" para cada datos.

{
    "type": "object",
    "required": [
        "type",
        "id"
    ],
    "properties": {
        "type": {
            "type": "string"
        },
        "id": {
            "type": "string"
        }
    },
    "additionalProperties": false
}

URLs relacionadas con los datos primarios.

{
    "type": "object",
    "allOf": [
        {
            "$ref": "#\/definitions\/links"
        }
    ]
}

Un objeto de recurso PUEDE contener referencias a otros objetos de recurso

{
    "type": "object",
    "properties": {
        "self": {
            "description": "Un mismo miembro, cuyo valor es una URL para los datos de relación",
            "type": "string",
            "format": "uri"
        },
        "related": {
            "type": "string",
            "format": "uri"
        }
    },
    "additionalProperties": false
}
              
{
    "type": "object",
    "required": [
        "meta",
        "errors"
    ],
    "properties": {
        "meta": {
            "$ref": "#\/definitions\/meta"
        },
        "errors": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "$ref": "#\/definitions\/error"
            }
        }
    },
    "additionalProperties": false
}
              
{
    "type": "object",
    "required": [
        "code",
        "detail"
    ],
    "properties": {
        "id": {
            "description": "Un identificador único para esta aparición particular del problema.",
            "type": "string",
            "example": "5f2d287a-3a3f-11e7-a919-92ebcb67fe33"
        },
        "href": {
            "description": "Un URI que ** PUEDE ** proporciona más detalles sobre esta ocurrencia particular del problema.",
            "type": "string",
            "example": "https:\/\/tools.ietf.org\/html\/rfc7231#section-6.5.4"
        },
        "status": {
            "description": "El código de estado HTTP aplicable a este problema, expresado como un valor de cadena.",
            "type": "string",
            "example": 404
        },
        "code": {
            "description": "Un código de error específico de la aplicación, expresado como un valor de cadena.",
            "type": "string",
            "example": "BP404"
        },
        "title": {
            "description": "Un breve resumen, legible por el hombre, del problema. ** NO DEBE ** cambiar de ocurrencia a ocurrencia del problema, excepto para propósitos de localización.",
            "type": "string",
            "example": "Not Found"
        },
        "detail": {
            "description": "Una explicación legible por humanos específica para esta ocurrencia del problema.",
            "type": "string",
            "example": "Requested resource could not be found"
        }
    },
    "additionalProperties": false
}